<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.1" />
<title>tronpytool.common.validation API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>tronpytool.common.validation</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python"># --------------------------------------------------------------------------------------------
# Copyright (c) iEXBase. All rights reserved.
# Licensed under the MIT License.
# See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import itertools
import re

from eth_utils import (
    function_abi_to_4byte_selector,
    apply_formatter_to_array
)

from trx_utils import (
    encode_hex,
    is_0x_prefixed,
    is_list_like,
    is_dict,
    is_string,
    is_bytes,
    is_boolean,
    is_integer,
    is_binary_address, is_hex_address, is_checksum_address)

from tronpytool.common.account import PrivateKey
from tronpytool.common.abi import filter_by_type, abi_to_signature, is_recognized_type, is_string_type, is_bytes_type, \
    is_address_type, is_int_type, is_uint_type, is_bool_type, sub_type_of_array_type, is_array_type, \
    length_of_array_type

from tronpytool.common.toolz import (
    compose,
    groupby,
    valfilter,
    valmap,
)
from tronpytool.exceptions import InvalidAddress


def _prepare_selector_collision_msg(duplicates):
    dup_sel = valmap(apply_formatter_to_array(abi_to_signature), duplicates)
    joined_funcs = valmap(lambda f: &#39;, &#39;.join(f), dup_sel)
    func_sel_msg_list = [funcs + &#39; have selector &#39; + sel for sel, funcs in joined_funcs.items()]
    return &#39; and\n&#39;.join(func_sel_msg_list)


def is_valid_url(value):
    &#34;&#34;&#34;Return whether or not given value is a valid URL.

    Args:
        value(str): URL address string to validate
    &#34;&#34;&#34;
    regex = re.compile(
        r&#39;^(?:http|ftp)s?://&#39;
        r&#39;(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|&#39;
        r&#39;localhost|&#39;
        r&#39;\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|&#39;
        r&#39;\[?[A-F0-9]*:[A-F0-9:]+\]?)&#39;
        r&#39;(?::\d+)?&#39;
        r&#39;(?:/?|[/?]\S+)$&#39;, re.IGNORECASE)

    result = regex.match(value)
    return bool(result)


def validate_abi(abi):
    &#34;&#34;&#34;
    Helper function for validating an ABI
    &#34;&#34;&#34;
    if not is_list_like(abi):
        raise ValueError(&#34;&#39;abi&#39; is not a list&#34;)

    if not all(is_dict(e) for e in abi):
        raise ValueError(&#34;&#39;abi&#39; is not a list of dictionaries&#34;)

    functions = filter_by_type(&#39;function&#39;, abi)
    selectors = groupby(
        compose(encode_hex, function_abi_to_4byte_selector),
        functions
    )
    duplicates = valfilter(lambda funcs: len(funcs) &gt; 1, selectors)
    if duplicates:
        raise ValueError(
            &#39;Abi contains functions with colliding selectors. &#39;
            &#39;Functions {0}&#39;.format(_prepare_selector_collision_msg(duplicates))
        )


def validate_abi_type(abi_type):
    &#34;&#34;&#34;
    Helper function for validating an abi_type
    &#34;&#34;&#34;
    if not is_recognized_type(abi_type):
        raise ValueError(&#34;Unrecognized abi_type: {abi_type}&#34;.format(abi_type=abi_type))


def validate_abi_value(abi_type, value):
    &#34;&#34;&#34;
    Helper function for validating a value against the expected abi_type
    Note: abi_type &#39;bytes&#39; must either be python3 &#39;bytes&#39; object or &#39;&#39;
    &#34;&#34;&#34;
    if is_array_type(abi_type) and is_list_like(value):
        # validate length
        specified_length = length_of_array_type(abi_type)
        if specified_length is not None:
            if specified_length &lt; 1:
                raise TypeError(
                    &#34;Invalid abi-type: {abi_type}. Length of fixed sized arrays&#34;
                    &#34;must be greater than 0.&#34;
                        .format(abi_type=abi_type)
                )
            if specified_length != len(value):
                raise TypeError(
                    &#34;The following array length does not the length specified&#34;
                    &#34;by the abi-type, {abi_type}: {value}&#34;
                        .format(abi_type=abi_type, value=value)
                )

        # validate sub_types
        sub_type = sub_type_of_array_type(abi_type)
        for v in value:
            validate_abi_value(sub_type, v)
        return
    elif is_bool_type(abi_type) and is_boolean(value):
        return
    elif is_uint_type(abi_type) and is_integer(value) and value &gt;= 0:
        return
    elif is_int_type(abi_type) and is_integer(value):
        return
    elif is_address_type(abi_type):
        validate_address(value)
        return
    elif is_bytes_type(abi_type):
        if is_bytes(value):
            return
        elif is_string(value):
            if is_0x_prefixed(value):
                return
            else:
                raise TypeError(
                    &#34;ABI values of abi-type &#39;bytes&#39; must be either&#34;
                    &#34;a python3 &#39;bytes&#39; object or an &#39;0x&#39; prefixed string.&#34;
                )
    elif is_string_type(abi_type) and is_string(value):
        return

    raise TypeError(
        &#34;The following abi value is not a &#39;{abi_type}&#39;: {value}&#34;.format(abi_type=abi_type, value=value)
    )


def validate_address(value):
    &#34;&#34;&#34;
    Helper function for validating an address
    &#34;&#34;&#34;
    if is_bytes(value):
        if not is_binary_address(value):
            raise InvalidAddress(&#34;Address must be 20 bytes when input type is bytes&#34;, value)
        return

    if not isinstance(value, str):
        raise TypeError(&#39;Address {} must be provided as a string&#39;.format(value))
    if not is_hex_address(value):
        raise InvalidAddress(&#34;Address must be 20 bytes, as a hex string with a 0x prefix&#34;, value)
    if not is_checksum_address(value):
        if value == value.lower():
            raise InvalidAddress(
                &#34;Web3.py only accepts checksum addresses. &#34;
                &#34;The software that gave you this non-checksum address should be considered unsafe, &#34;
                &#34;please file it as a bug on their platform. &#34;
                &#34;Try using an ENS name instead. Or, if you must accept lower safety, &#34;
                &#34;use Web3.toChecksumAddress(lower_case_address).&#34;,
                value,
            )
        else:
            raise InvalidAddress(
                &#34;Address has an invalid EIP-55 checksum. &#34;
                &#34;After looking up the address from the original source, try again.&#34;,
                value,
            )


def has_one_val(*args, **kwargs):
    vals = itertools.chain(args, kwargs.values())
    not_nones = list(filter(lambda val: val is not None, vals))
    return len(not_nones) == 1


def assert_one_val(*args, **kwargs):
    if not has_one_val(*args, **kwargs):
        raise TypeError(
            &#34;Exactly one of the passed values can be specified. &#34;
            &#34;Instead, values were: %r, %r&#34; % (args, kwargs)
        )


def is_private_key(i: any) -&gt; bool:
    return isinstance(i, PrivateKey)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="tronpytool.common.validation.assert_one_val"><code class="name flex">
<span>def <span class="ident">assert_one_val</span></span>(<span>*args, **kwargs)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def assert_one_val(*args, **kwargs):
    if not has_one_val(*args, **kwargs):
        raise TypeError(
            &#34;Exactly one of the passed values can be specified. &#34;
            &#34;Instead, values were: %r, %r&#34; % (args, kwargs)
        )</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.has_one_val"><code class="name flex">
<span>def <span class="ident">has_one_val</span></span>(<span>*args, **kwargs)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def has_one_val(*args, **kwargs):
    vals = itertools.chain(args, kwargs.values())
    not_nones = list(filter(lambda val: val is not None, vals))
    return len(not_nones) == 1</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.is_private_key"><code class="name flex">
<span>def <span class="ident">is_private_key</span></span>(<span>i: <built-in function any>) ‑> bool</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def is_private_key(i: any) -&gt; bool:
    return isinstance(i, PrivateKey)</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.is_valid_url"><code class="name flex">
<span>def <span class="ident">is_valid_url</span></span>(<span>value)</span>
</code></dt>
<dd>
<div class="desc"><p>Return whether or not given value is a valid URL.</p>
<h2 id="args">Args</h2>
<p>value(str): URL address string to validate</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def is_valid_url(value):
    &#34;&#34;&#34;Return whether or not given value is a valid URL.

    Args:
        value(str): URL address string to validate
    &#34;&#34;&#34;
    regex = re.compile(
        r&#39;^(?:http|ftp)s?://&#39;
        r&#39;(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|&#39;
        r&#39;localhost|&#39;
        r&#39;\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|&#39;
        r&#39;\[?[A-F0-9]*:[A-F0-9:]+\]?)&#39;
        r&#39;(?::\d+)?&#39;
        r&#39;(?:/?|[/?]\S+)$&#39;, re.IGNORECASE)

    result = regex.match(value)
    return bool(result)</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.validate_abi"><code class="name flex">
<span>def <span class="ident">validate_abi</span></span>(<span>abi)</span>
</code></dt>
<dd>
<div class="desc"><p>Helper function for validating an ABI</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_abi(abi):
    &#34;&#34;&#34;
    Helper function for validating an ABI
    &#34;&#34;&#34;
    if not is_list_like(abi):
        raise ValueError(&#34;&#39;abi&#39; is not a list&#34;)

    if not all(is_dict(e) for e in abi):
        raise ValueError(&#34;&#39;abi&#39; is not a list of dictionaries&#34;)

    functions = filter_by_type(&#39;function&#39;, abi)
    selectors = groupby(
        compose(encode_hex, function_abi_to_4byte_selector),
        functions
    )
    duplicates = valfilter(lambda funcs: len(funcs) &gt; 1, selectors)
    if duplicates:
        raise ValueError(
            &#39;Abi contains functions with colliding selectors. &#39;
            &#39;Functions {0}&#39;.format(_prepare_selector_collision_msg(duplicates))
        )</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.validate_abi_type"><code class="name flex">
<span>def <span class="ident">validate_abi_type</span></span>(<span>abi_type)</span>
</code></dt>
<dd>
<div class="desc"><p>Helper function for validating an abi_type</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_abi_type(abi_type):
    &#34;&#34;&#34;
    Helper function for validating an abi_type
    &#34;&#34;&#34;
    if not is_recognized_type(abi_type):
        raise ValueError(&#34;Unrecognized abi_type: {abi_type}&#34;.format(abi_type=abi_type))</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.validate_abi_value"><code class="name flex">
<span>def <span class="ident">validate_abi_value</span></span>(<span>abi_type, value)</span>
</code></dt>
<dd>
<div class="desc"><p>Helper function for validating a value against the expected abi_type
Note: abi_type 'bytes' must either be python3 'bytes' object or ''</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_abi_value(abi_type, value):
    &#34;&#34;&#34;
    Helper function for validating a value against the expected abi_type
    Note: abi_type &#39;bytes&#39; must either be python3 &#39;bytes&#39; object or &#39;&#39;
    &#34;&#34;&#34;
    if is_array_type(abi_type) and is_list_like(value):
        # validate length
        specified_length = length_of_array_type(abi_type)
        if specified_length is not None:
            if specified_length &lt; 1:
                raise TypeError(
                    &#34;Invalid abi-type: {abi_type}. Length of fixed sized arrays&#34;
                    &#34;must be greater than 0.&#34;
                        .format(abi_type=abi_type)
                )
            if specified_length != len(value):
                raise TypeError(
                    &#34;The following array length does not the length specified&#34;
                    &#34;by the abi-type, {abi_type}: {value}&#34;
                        .format(abi_type=abi_type, value=value)
                )

        # validate sub_types
        sub_type = sub_type_of_array_type(abi_type)
        for v in value:
            validate_abi_value(sub_type, v)
        return
    elif is_bool_type(abi_type) and is_boolean(value):
        return
    elif is_uint_type(abi_type) and is_integer(value) and value &gt;= 0:
        return
    elif is_int_type(abi_type) and is_integer(value):
        return
    elif is_address_type(abi_type):
        validate_address(value)
        return
    elif is_bytes_type(abi_type):
        if is_bytes(value):
            return
        elif is_string(value):
            if is_0x_prefixed(value):
                return
            else:
                raise TypeError(
                    &#34;ABI values of abi-type &#39;bytes&#39; must be either&#34;
                    &#34;a python3 &#39;bytes&#39; object or an &#39;0x&#39; prefixed string.&#34;
                )
    elif is_string_type(abi_type) and is_string(value):
        return

    raise TypeError(
        &#34;The following abi value is not a &#39;{abi_type}&#39;: {value}&#34;.format(abi_type=abi_type, value=value)
    )</code></pre>
</details>
</dd>
<dt id="tronpytool.common.validation.validate_address"><code class="name flex">
<span>def <span class="ident">validate_address</span></span>(<span>value)</span>
</code></dt>
<dd>
<div class="desc"><p>Helper function for validating an address</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_address(value):
    &#34;&#34;&#34;
    Helper function for validating an address
    &#34;&#34;&#34;
    if is_bytes(value):
        if not is_binary_address(value):
            raise InvalidAddress(&#34;Address must be 20 bytes when input type is bytes&#34;, value)
        return

    if not isinstance(value, str):
        raise TypeError(&#39;Address {} must be provided as a string&#39;.format(value))
    if not is_hex_address(value):
        raise InvalidAddress(&#34;Address must be 20 bytes, as a hex string with a 0x prefix&#34;, value)
    if not is_checksum_address(value):
        if value == value.lower():
            raise InvalidAddress(
                &#34;Web3.py only accepts checksum addresses. &#34;
                &#34;The software that gave you this non-checksum address should be considered unsafe, &#34;
                &#34;please file it as a bug on their platform. &#34;
                &#34;Try using an ENS name instead. Or, if you must accept lower safety, &#34;
                &#34;use Web3.toChecksumAddress(lower_case_address).&#34;,
                value,
            )
        else:
            raise InvalidAddress(
                &#34;Address has an invalid EIP-55 checksum. &#34;
                &#34;After looking up the address from the original source, try again.&#34;,
                value,
            )</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="tronpytool.common" href="index.html">tronpytool.common</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="two-column">
<li><code><a title="tronpytool.common.validation.assert_one_val" href="#tronpytool.common.validation.assert_one_val">assert_one_val</a></code></li>
<li><code><a title="tronpytool.common.validation.has_one_val" href="#tronpytool.common.validation.has_one_val">has_one_val</a></code></li>
<li><code><a title="tronpytool.common.validation.is_private_key" href="#tronpytool.common.validation.is_private_key">is_private_key</a></code></li>
<li><code><a title="tronpytool.common.validation.is_valid_url" href="#tronpytool.common.validation.is_valid_url">is_valid_url</a></code></li>
<li><code><a title="tronpytool.common.validation.validate_abi" href="#tronpytool.common.validation.validate_abi">validate_abi</a></code></li>
<li><code><a title="tronpytool.common.validation.validate_abi_type" href="#tronpytool.common.validation.validate_abi_type">validate_abi_type</a></code></li>
<li><code><a title="tronpytool.common.validation.validate_abi_value" href="#tronpytool.common.validation.validate_abi_value">validate_abi_value</a></code></li>
<li><code><a title="tronpytool.common.validation.validate_address" href="#tronpytool.common.validation.validate_address">validate_address</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
</footer>
</body>
</html>